Platform Explorer / Nuxeo Platform LTS 2016 8.10

Operation Repository.ResultSetPageProvider (QueryAndFetch)

Description

Perform a query or a named provider query on the repository. Result is paginated. The result is returned as a RecordSet (QueryAndFetch) rather than as a List of DocumentThe query result will become the input for the next operation. If no query or provider name is given, a query returning all the documents that the user has access to will be executed.
Operation id Repository.ResultSetPageProvider
AliasesResultset.PageProvider
Category Fetch
Label QueryAndFetch
Requires
Since

Parameters

Name Description Type Required Default value
documentLinkBuilder string no  
language string no NXQL, CMIS 
maxResults string no  
namedParameters properties no  
page integer no  
pageSize integer no  
providerName string no  
query string no  
queryParams stringlist no  
sortBy string no  
sortInfo stringlist no  
sortOrder string no ASC, DESC 

Signature

Inputs void
Outputs recordset

Implementation Information

Implementation Class Class: org.nuxeo.ecm.automation.core.operations.services.ResultSetPageProviderOperation
Contributing Component org.nuxeo.ecm.core.automation.featuresContrib

JSON Definition

{
  "id" : "Repository.ResultSetPageProvider",
  "aliases" : [ "Resultset.PageProvider" ],
  "label" : "QueryAndFetch",
  "category" : "Fetch",
  "requires" : null,
  "description" : "Perform a query or a named provider query on the repository. Result is paginated. The result is returned as a RecordSet (QueryAndFetch) rather than as a List of DocumentThe query result will become the input for the next operation. If no query or provider name is given, a query returning all the documents that the user has access to will be executed.",
  "url" : "Repository.ResultSetPageProvider",
  "signature" : [ "void", "recordset" ],
  "params" : [ {
    "name" : "documentLinkBuilder",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "language",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "NXQL", "CMIS" ]
  }, {
    "name" : "maxResults",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "namedParameters",
    "description" : null,
    "type" : "properties",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "page",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "pageSize",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "providerName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "query",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "queryParams",
    "description" : null,
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortBy",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortInfo",
    "description" : null,
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortOrder",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "ASC", "DESC" ]
  } ]
}